home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / diskutil / tc60_bin.lzh / TCACHE.60 / DOCS / TC60ENGL.TXT < prev    next >
Encoding:
Text File  |  1993-03-06  |  13.5 KB  |  286 lines
  1.                                                 Ralf Biedermann
  2.                                                 Ortfeld 3
  3.                                               W-2815 Langwedel
  4.                                                 Germany
  5.                                                 (49) 4235-8407
  6.                                            Maus:Ralf Biedermann @ HB
  7.                                            Fido:Ralf Biedermann on 2:241/2021.1
  8.                                            
  9.                                           
  10. Short documentation of TCache:
  11.  
  12. 0. General information !
  13.  
  14. TCache  is  charityware  which  means  that  if  you like TCache and use it
  15. regulary  you  have to make a donation for an animalcharity. If you send me
  16. a  proof  of  your  donation  you'll  receive  the latest version of TCache
  17. including  commented  sourcecode  (comments  in german sorry). If you write
  18. from  inside  germany  include  a  stamped  self addressed envelope. If you
  19. write from outside germany include 2 IRC and an self addressed envelope.
  20.  
  21. The latest version of TCache can be frequested on
  22. Spice-Box (49)-7154-180017 under the MAGIC TCACHE
  23.    the Spice-Box is member of the following nets
  24.          FidoNet: 2:2407/  43
  25.          GerNet :21: 100/1201
  26.          NeST   :90: 400/ 206
  27.  
  28. 1. What is TCache ?
  29.  
  30. TCache  is  a  very  fast  Harddisk-Cache  for the Atari range of computers
  31. (ST/STE/TT/Falcon).  A  cacheprogram  stores  sectors from disk/harddisk in
  32. ram and increases the speed of repeated access.
  33.  
  34. 2. How to install TCache ?
  35.  
  36. You  must  copy TCache60.PRG into the autofolder of your bootdrive. Because
  37. TCache  is  deactivated  after the first installation you have to make some
  38. configurations   using   the   accessory   TC_ACC60.ACC.   You  can  rename
  39. TC_ACC60.ACC  to  TC60_ACC.PRG  and  start  a  from  the desktop or you put
  40. TC_ACC60.ACC  into the rootdirectory of your bootdrive and perform a reset.
  41. Now  you have to make the apropriate changes to the configuration of TCache
  42. und  save  it  directly  in the programcode of TCache60.PRG. The meaning of
  43. every option will be explained in the next chapter.
  44.  
  45. 3. Options of TCache
  46.  
  47. With  the  programm  TC_ACC60.ACC  (.PRG!)  you  can change every option of
  48. TCache.  In  this chapter I will try to explain every possibility in simple
  49. words, because I can't explain it in detail in english.
  50.  
  51. - If you click on the top-button you will receive the following 
  52.   informations:
  53.   - Name of the author (me).
  54.   - Bootdev, the single letter in the top row.
  55.   - over all memory requirement, in the button.
  56.   Φ
  57. - on the right are five radiobuttons. If you press one of the buttons the 
  58.   information in the big area on the left side might get a new contents.
  59.   - 'Einstellungen' will let you change the options for every drive. These 
  60.     options must be set for every drive.
  61.   - 'Parameter' shows some global values of TCache, this means that these 
  62.     option are valid for all drives.
  63.   - 'Statistik' gives statistical informations about the success of 
  64.     cacheing for every drive.
  65.   - 'Spezial' hides two interesting features of TCache. One denies access 
  66.     for choosen drives without a password and the second redirects access 
  67.     to one drive to another one.
  68.   - 'Zubehör' hides some global options and more special features.
  69.   
  70. - under the radiobuttons are 16 more radiobuttons labeled with 'A'..'P', 
  71.   with these buttons you can select a drive for wich you want to see the 
  72.   local options ('Einstellungen') or the statistics ('Statistik'). If you 
  73.   have selected neither 'Parameter' nor 'Spezial' or 'Zubehör' these buttons 
  74.   will have no effekt.
  75.   
  76. - 'Ok' will configure TCache60.PRG according to your changes and leave the 
  77.   ACC. The changes are not permanent, after a reset your old values are 
  78.   valid.
  79.   
  80. - 'Speichern' will save your changes directly in the file TCache60.PRG. You 
  81.   have to select the correct file with the fileselectorbox. After the 
  82.   changes were saved the ACC will be leaved. When you try to save something 
  83.   it  will  be  validated if it is a program which contains TCache60 so you 
  84.   could even rename the program.
  85.   
  86. - 'Abbruch' means abbort and none of your changes will be taken and the ACC 
  87.   will be leaved. 
  88.   
  89.  
  90. Now some explanations of 'Einstellungen'
  91. 'Einstellungen' must be made for every drive (click on 'A'..'P').
  92.  
  93. - 'Laufwerk aktiv' means that the drive selected (bottom right) will be 
  94.   cached  according  to  your  further configuration. If this button is not 
  95.   selected none of the other option for this drive will be active.
  96.   
  97. - 'Änderungen schreiben' means that only sectors with a changed contents 
  98.   will be written to disk.
  99.   
  100. - 'Schreiben verzögern' means that a writeoperation will be delayed for a 
  101.   while. This is a bit dangerous because not every information will be 
  102.   immediatly on disk, if the computer crashes before the information is 
  103.   written it can result in a los of data. But this option is very usefull 
  104.   because a lot of datahandling will be speeded up quite a bit. The best 
  105.   example is deleting a lot of files with 'Schreiben verzögern' it will 
  106.   have the speed of most ramdiscs.
  107.   
  108. - 'Schreibschutz' is a software writeprotect for the selected drive.
  109.  
  110. - 'Checksumme bilden' informs TCache to calculate a checksum for every sector. 
  111.   This option is only usefull while testing new programs or during 
  112.   programdevelopment because the speed will go down dramaticly.
  113.   
  114. - 'Fat & Root-Dir sperren' means that sectors belonging to either FAT (file 
  115.   allocation table) or the rootdirectory will be locked in cache, they 
  116.   can't be overwritten. If you use only 32..256K for cache this option can 
  117.   speed up things a bit.
  118.   
  119. - 'Mediach() bei HIT' means that for every cachehit (sector is found in 
  120.   cache) the program checks if the media was changed in the meantime. This 
  121.   option must be activ for every medium which could be changed, f.i. 
  122.   floppydiscs. On harddiscs it's faster to leave this option unset.
  123.   
  124. - On the bottom is a row of radiobuttons labeled '0'..'9'. Theses buttons 
  125.   are used to configure the so called readprefetch. Readprefetch means 
  126.   reading more sectors in one call than GEMDOS wants to. If GEMDOS wants 
  127.   only one sector TCache reads more sectors and stores them in cache, if 
  128.   GEMDOS wants the next sector it is already in ram and the speed will be 
  129.   very high. With these buttons you can select the number of sectors TCache 
  130.   reads instead of only one sector.
  131.   
  132. Now some explanations of 'Parameter'
  133.  
  134. - 'Cachegröße' is the amount of ram you wants to use for TCache. TCache is 
  135.   very fast even if you try >1MB so don't be afraid to test large amounts.
  136.   
  137. - 'Hashtabelle' is a value which has something to do with finding a sector 
  138.   in cache. A value of '16' is the fastest possibility but it will use a 
  139.   further 256K of ram. Normally values between 10..12 should be fast enough
  140.   and they will cost only 4..16K of ram.
  141.   
  142. - 'max. Prefetch' is the size of a buffer used for prefetch and writing 
  143.   blocks back to disc. Values between 16..32 are all right.
  144.   
  145. - 'Leseblock' is the largest block which will be completly stored in cache 
  146.   if possible. If a block is bigger than these amount of sectors it will be 
  147.   directly read from disc. Making this value to big will cost some speed 
  148.   for some operations.
  149.   
  150. - 'Schreibblock' the same as 'Leseblock' with the difference that 
  151.   writeoperations are meant. 
  152.  
  153. - 'Flushzeit' is the amount of time a writeoperation will be delayed if the 
  154.   'Einstellungen' 'Schreiben verzögern' is activ. The lower the saver and 
  155.   the higher the faster is TCache.
  156.  
  157. - 'Belegungsgrad' shows how full cache is. If the number is inverted 
  158.   than  the  cache  is  full  of  locked  data. The second number shows the 
  159.   percentage  of  Cache  used  by locked data, f.i. FAT-sectors if you have 
  160.   selected 'FAT & RootDir' for at least one drive.
  161.  
  162. - 'LED' lets your floppy-led flash for every harddiscaccess.
  163.  
  164. - 'CLR' will flush and clear cachememory.
  165.  
  166. - 'LOCK' all sectors will be locked in cache (see 'Fat & Root-Dir sperren')
  167.  
  168. - 'AKTIV' enables or disables TCache completly.
  169.  
  170. Now some explanations of 'Statistik'
  171. 'Statistik' can be seen for every drive (click on 'A'..'P').
  172.  
  173. - 'Lesezugriffe' number of readaccesses since start of TCache.
  174.  
  175. - 'Treffer' readhits since start of TCache. Number of saved readaccesses.
  176.  
  177. - 'Schreibzugriffe' number of writeaccesses since start of TCache.
  178.  
  179. - 'Treffer' writehits since start of TCache. Number of saved writeaccesses.
  180.  
  181. - 'Prüfsummenfehler' number af checksumerrors since start of TCache. This 
  182.    value is only of interest if 'Checksumme bilden' is activ for one or 
  183.    more drives.
  184.    
  185. - 'ungerade Adressen' shows the number of reads/writes to/from odd 
  186.   addresses. This can be of interest for program testing/developing because 
  187.   a normal ST/STE is a lot slower in accessing odd adresses.
  188.   
  189. - 'freier Speicher' shows the amount of free memory on the selected drive.
  190.  
  191. - 'Sektorgröße' shows the size of one sector for the selected drive.
  192.  
  193. Now some explanations of 'Spezial'
  194.  
  195. - The top half of this area is used for a security option. 'Zugriffsschutz 
  196.   für Laufwerke' can protect one or more drives against unwanted accesses 
  197.   from your boss/brother. You must make your configuration AND enter the 
  198.   password ('Passwort'). You won't see the password because it's hidden. On 
  199.   delivery the password is set to 'TCRB'. If you want to change this 
  200.   password take a fileeditor and search for the string 'PASSTCRB' in the 
  201.   file TCache60.PRG and change 'TCRB' in this string against your new 
  202.   password.
  203.   
  204. - The bottom half allows you to redirect the access from one drive to another 
  205.   drive. With the arrows you can select the drive you would like to be 
  206.   redirected. With the radiobuttons beneath you can select the drive to 
  207.   which the accesses will be redirected.
  208.   
  209. Now some explanations of 'Zubehör'
  210.  
  211. - 'Ramdisk' shows another menue which allows you to install a ramdisk. Just 
  212.   select the drive and the amount of ram and press 'installieren'. If there 
  213.   is already a ramdisk installed press 'entfernen' to remove this one. The 
  214.   ramdisc is very fast but not resetresident.
  215.   
  216. - 'ACC-Ordner' shows another menue from which you can select a folder from 
  217.   which the ACC's will be loaded after the next reset. Of course you must 
  218.   save the configuration for the desired result. To select the path simply 
  219.   click on the pathname and a fileselectorbox will apear. The button 'laden 
  220.   aus Ordner' must be selected as well.
  221.   
  222. - 'Steprate' allows you to switch the steprate for drive 'A' or 'B'. Simply 
  223.   select the desired steprate for drive 'A' (top row) and 'B' (second row) 
  224.   and select 'setze Stepraten'. If you save the TCache-configuration the 
  225.   steprates will be set on boot.
  226.   
  227. - 'virtuell' shows a menue which lets you install logical drives, these are 
  228.   drives which aren't physicly attached to your computer. Together with 
  229.   'Spezial' 'Zugriffsumlenkung von ? auf' you can create alsmost every 
  230.   harddisc configuration. This option is especially usefull if you want to 
  231.   install a programm which is conigured for drives which are absent on your 
  232.   computer.
  233.  
  234. - Information  shows  another menu  with further global informations. These 
  235.   informations are:
  236.   'absolut Lesen' Rwabs()-readmode >= 8
  237.   'absolut Schreiben' Rwbas()-writemode >= 8
  238.   'Schreibfehler' number of problems during delayed write
  239.   'einzelne Zugriffe' number of singlesectoraccesses
  240.   'mehrere Zugriffe' number of multisectoraccesses
  241.   'gesamt Zugriffe' total number of accesses 
  242.   'gesamt gespart' number of saved accesses
  243.   
  244. - 'Absolut' allows or denies accesses to a drive in an absolut manor which 
  245.   means  access to a drive without using partitioninformation. If you wants 
  246.   to partition your HD absolut must be allowed.
  247.  
  248. - 'Testing' hows if the ACC should test TCache every five seconds or not.
  249.  
  250. - 'PUN-INFO'  is  a  flag which tells TCache to use the so called PUN-INFO 
  251.   strucure  to  get  informations  about  the largest sectorsize. If is not 
  252.   selected TCache makes a Getbpb() for every drive on starup.
  253.  
  254. -  'NOX  !' is a very special thing. If you have a cookie called 'NOX!' and 
  255.   the  value  of this cookie is a pointer to a subroutine then on start and 
  256.   end of a Rwabs()-call this routine will be called.
  257.   
  258. - 'Drvbit-Check' checks the systemvariable '_drvbits' and denies every 
  259.   access to a drive which isn't in '_drvbis' (anymore). It's main interest 
  260.   is in program testing/developing.
  261.   
  262. - 'XBra-Check' is an option for TCache. TCache checks its programcode 
  263.   everytime you leave a program. TCache uses the XBRA-standard and if 
  264.   anyone changes something in the programmcode TCache deinstalls itself. 
  265.   With this switch you can select whether TCache should allow manipulations 
  266.   in his XBRA-structure or not.
  267.   
  268. - 'etv_term' means that every time you leave a program the cache will be 
  269.   flushed. Only of interest if 'Schreiben verzögern' is activ for one or 
  270.   more drives.
  271.   
  272. - 'WriteReset' if selected TCache tries to flush the cache even if someone 
  273.   has pressed 'CTRL+ALT+DEL' (warmreset). Only of interest if 'Schreiben 
  274.   verzögern' is activ for one or more drives.
  275.   
  276. - 'Gemdos' if selected even the directories of folders are locked in cache. 
  277.   Attention this option needs a lot of ram, even on small harddiscs are 
  278.   >512K recommended.
  279.   
  280. - 'Uhr' reads a special version of a hardwareclock on normal ST's during 
  281.   booting.
  282.     
  283.     
  284. Sorry for this short document but I hope it's of help most of you.
  285. Regards Ralf
  286.